<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>PxSceneWriteLock Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  $(document).ready(initResizable);
/* @license-end */</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="PhysXLogoBlack.png"/></td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('classPxSceneWriteLock.html','');});
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-methods">Private Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classPxSceneWriteLock-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">PxSceneWriteLock Class Reference<div class="ingroups"><a class="el" href="group__physics.html">Physics</a></div></div>  </div>
</div><!--header-->
<div class="contents">

<p>RAII wrapper for the <a class="el" href="classPxScene.html" title="A scene is a collection of bodies and constraints which can interact. ">PxScene</a> write lock.  
 <a href="classPxSceneWriteLock.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="PxSceneLock_8h_source.html">PxSceneLock.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for PxSceneWriteLock:</div>
<div class="dyncontent">
<div class="center"><img src="classPxSceneWriteLock__coll__graph.png" border="0" usemap="#PxSceneWriteLock_coll__map" alt="Collaboration graph"/></div>
<map name="PxSceneWriteLock_coll__map" id="PxSceneWriteLock_coll__map">
<area shape="rect" id="node2" href="classPxScene.html" title="A scene is a collection of bodies and constraints which can interact. " alt="" coords="35,5,110,32"/>
</map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a3171b8380aa5aecf8f80fcffb347290a"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxSceneWriteLock.html#a3171b8380aa5aecf8f80fcffb347290a">PxSceneWriteLock</a> (<a class="el" href="classPxScene.html">PxScene</a> &amp;scene, const char *file=NULL, <a class="el" href="group__foundation.html#gacce5749db3dcfb916e98c253374264ed">PxU32</a> line=0)</td></tr>
<tr class="memdesc:a3171b8380aa5aecf8f80fcffb347290a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#a3171b8380aa5aecf8f80fcffb347290a">More...</a><br /></td></tr>
<tr class="separator:a3171b8380aa5aecf8f80fcffb347290a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a35e6e8dc88be6e7dfcc1567181af09d3"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxSceneWriteLock.html#a35e6e8dc88be6e7dfcc1567181af09d3">~PxSceneWriteLock</a> ()</td></tr>
<tr class="separator:a35e6e8dc88be6e7dfcc1567181af09d3"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-methods"></a>
Private Member Functions</h2></td></tr>
<tr class="memitem:a79dfa45a702ade06c4ca4af9de6ea160"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxSceneWriteLock.html#a79dfa45a702ade06c4ca4af9de6ea160">PxSceneWriteLock</a> (const <a class="el" href="classPxSceneWriteLock.html">PxSceneWriteLock</a> &amp;)</td></tr>
<tr class="separator:a79dfa45a702ade06c4ca4af9de6ea160"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a09e6d3e1544bf51e7f60ed43b2a60909"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classPxSceneWriteLock.html">PxSceneWriteLock</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxSceneWriteLock.html#a09e6d3e1544bf51e7f60ed43b2a60909">operator=</a> (const <a class="el" href="classPxSceneWriteLock.html">PxSceneWriteLock</a> &amp;)</td></tr>
<tr class="separator:a09e6d3e1544bf51e7f60ed43b2a60909"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:ace8fdd1122b661e18b2bcec225ede3a9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classPxScene.html">PxScene</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxSceneWriteLock.html#ace8fdd1122b661e18b2bcec225ede3a9">mScene</a></td></tr>
<tr class="separator:ace8fdd1122b661e18b2bcec225ede3a9"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>RAII wrapper for the <a class="el" href="classPxScene.html" title="A scene is a collection of bodies and constraints which can interact. ">PxScene</a> write lock. </p>
<p>Use this class as follows to lock the scene for writing by the current thread for the duration of the enclosing scope:</p>
<p><a class="el" href="classPxSceneWriteLock.html" title="RAII wrapper for the PxScene write lock. ">PxSceneWriteLock</a> lock(sceneRef);</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classPxScene.html#a89d45878685fa31bb2684c096d2c6918" title="Lock the scene for writing from this thread. ">PxScene::lockWrite()</a>, <a class="el" href="classPxScene.html#af2fa25d740641e78ae934c0488f17a4d" title="Unlock the scene from writing. ">PxScene::unlockWrite()</a>, <a class="el" href="structPxSceneFlag.html#ab4c347372b4433d34d983da780916c53a97a4bafb1db3bba4b8ff373e16d67c5b" title="Require scene-level locking. ">PxSceneFlag::eREQUIRE_RW_LOCK</a> </dd></dl>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a79dfa45a702ade06c4ca4af9de6ea160"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a79dfa45a702ade06c4ca4af9de6ea160">&#9670;&nbsp;</a></span>PxSceneWriteLock() <span class="overload">[1/2]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">PxSceneWriteLock::PxSceneWriteLock </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classPxSceneWriteLock.html">PxSceneWriteLock</a> &amp;&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a id="a3171b8380aa5aecf8f80fcffb347290a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3171b8380aa5aecf8f80fcffb347290a">&#9670;&nbsp;</a></span>PxSceneWriteLock() <span class="overload">[2/2]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">PxSceneWriteLock::PxSceneWriteLock </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classPxScene.html">PxScene</a> &amp;&#160;</td>
          <td class="paramname"><em>scene</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>file</em> = <code>NULL</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__foundation.html#gacce5749db3dcfb916e98c253374264ed">PxU32</a>&#160;</td>
          <td class="paramname"><em>line</em> = <code>0</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Constructor. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">scene</td><td>The scene to lock for writing </td></tr>
    <tr><td class="paramname">file</td><td>Optional string for debugging purposes </td></tr>
    <tr><td class="paramname">line</td><td>Optional line number for debugging purposes </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="a35e6e8dc88be6e7dfcc1567181af09d3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a35e6e8dc88be6e7dfcc1567181af09d3">&#9670;&nbsp;</a></span>~PxSceneWriteLock()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">PxSceneWriteLock::~PxSceneWriteLock </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a09e6d3e1544bf51e7f60ed43b2a60909"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a09e6d3e1544bf51e7f60ed43b2a60909">&#9670;&nbsp;</a></span>operator=()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classPxSceneWriteLock.html">PxSceneWriteLock</a>&amp; PxSceneWriteLock::operator= </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classPxSceneWriteLock.html">PxSceneWriteLock</a> &amp;&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="ace8fdd1122b661e18b2bcec225ede3a9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ace8fdd1122b661e18b2bcec225ede3a9">&#9670;&nbsp;</a></span>mScene</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classPxScene.html">PxScene</a>&amp; PxSceneWriteLock::mScene</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="PxSceneLock_8h_source.html">PxSceneLock.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.8.14-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="classPxSceneWriteLock.html">PxSceneWriteLock</a></li>
    <li class="footer">Copyright &copy; 2008-2021 NVIDIA Corporation, 2788 San Tomas Expressway, Santa Clara, CA 95051 U.S.A. All rights reserved. <a href="http://www.nvidia.com ">www.nvidia.com</a></li>
  </ul>
</div>
</body>
</html>
